Skip to content

revert: artist detail endpoint reference#117

Merged
arpitgupta1214 merged 1 commit intomainfrom
codex/revert-artist-read-docs
Apr 9, 2026
Merged

revert: artist detail endpoint reference#117
arpitgupta1214 merged 1 commit intomainfrom
codex/revert-artist-read-docs

Conversation

@arpitgupta1214
Copy link
Copy Markdown
Collaborator

@arpitgupta1214 arpitgupta1214 commented Apr 9, 2026

Reverts the merged artist detail docs from #116.

This undo PR removes the GET /api/artists/{id} docs, OpenAPI entry, and nav item so docs stay aligned with the reverted API surface.


Summary by cubic

Reverts the artist detail endpoint docs to match the current API. Removes GET /api/artists/{id} from the docs, OpenAPI, and nav, and drops related schemas.

  • Migration
    • OpenAPI change: ArtistsErrorResponse now uses message (not error) and no longer includes missing_fields. Adjust clients that parse this schema.

Written for commit a9664dd. Summary will update on new commits.

Summary by CodeRabbit

  • Revert

    • Removed individual artist lookup endpoint.
    • Updated Artists API error response format.
  • Documentation

    • Removed associated endpoint documentation and navigation entries.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 9, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d3b69fb7-8443-4247-87a4-6a13e856cefd

📥 Commits

Reviewing files that changed from the base of the PR and between c9e7f9f and a9664dd.

📒 Files selected for processing (3)
  • api-reference/artists/get.mdx
  • api-reference/openapi.json
  • docs.json
💤 Files with no reviewable changes (2)
  • api-reference/artists/get.mdx
  • docs.json

📝 Walkthrough

Walkthrough

This PR removes the GET /api/artists/{id} endpoint documentation, including its OpenAPI specification, related schema definitions, navigation configuration, and associated documentation page.

Changes

Cohort / File(s) Summary
Documentation Page Removal
api-reference/artists/get.mdx
Removed frontmatter metadata (title and OpenAPI operation reference) for the artist detail endpoint documentation.
API Specification Updates
api-reference/openapi.json
Removed the GET /api/artists/{id} endpoint path and its associated response schemas (GetArtistResponse, ArtistDetail, ArtistAccountSocial). Updated ArtistsErrorResponse schema to replace error field with message and removed missing_fields property.
Navigation Configuration
docs.json
Removed the navigation entry for api-reference/artists/get from the Releases → Artists section.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • docs: add artist detail endpoint reference #116: Main PR removes the GET /api/artists/{id} documentation, OpenAPI path, and related schemas that this PR was adding — represents the inverse operation touching the same endpoint, files, and schema definitions.

Suggested reviewers

  • sweetmantech

Poem

🐰 A path once trod now fades away,
The artist endpoint bids goodbye today!
With schemas swept and docs so neat,
Our API's simpler, more complete!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'revert: artist detail endpoint reference' accurately describes the main change: reverting the artist detail endpoint documentation and OpenAPI definitions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/revert-artist-read-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@arpitgupta1214 arpitgupta1214 merged commit 097a526 into main Apr 9, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants